Autogenerated HTML docs for v2.2.0-rc0
diff --git a/technical/api-tree-walking.html b/technical/api-tree-walking.html index 0e9d56d..2ddd698 100644 --- a/technical/api-tree-walking.html +++ b/technical/api-tree-walking.html
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.6" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>tree walking API</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ @@ -87,10 +87,16 @@ ul > li { color: #aaa; } ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } +pre { + white-space: pre-wrap; +} #author { color: #527bbd; @@ -219,7 +225,7 @@ } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl { @@ -349,7 +355,7 @@ margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -407,18 +413,14 @@ span.overline { text-decoration: overline; } span.line-through { text-decoration: line-through; } +div.unbreakable { page-break-inside: avoid; } + /* * xhtml11 specific * * */ -tt { - font-family: monospace; - font-size: inherit; - color: navy; -} - div.tableblock { margin-top: 1.0em; margin-bottom: 1.5em; @@ -452,12 +454,6 @@ * * */ -.monospaced { - font-family: monospace; - font-size: inherit; - color: navy; -} - table.tableblock { margin-top: 1.0em; margin-bottom: 1.5em; @@ -537,6 +533,8 @@ @media print { body.manpage div#toc { display: none; } } + + </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -610,7 +608,7 @@ var i; for (i = 0; i < toc.childNodes.length; i++) { var entry = toc.childNodes[i]; - if (entry.nodeName == 'div' + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") && entry.getAttribute("class").match(/^toclevel/)) tocEntriesToRemove.push(entry); @@ -656,7 +654,7 @@ var entriesToRemove = []; for (i = 0; i < noteholder.childNodes.length; i++) { var entry = noteholder.childNodes[i]; - if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote") + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") entriesToRemove.push(entry); } for (i = 0; i < entriesToRemove.length; i++) { @@ -748,7 +746,7 @@ <div class="sectionbody"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>struct name_entry</tt> +<code>struct name_entry</code> </dt> <dd> <p> @@ -757,7 +755,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>struct tree_desc</tt> +<code>struct tree_desc</code> </dt> <dd> <p> @@ -767,24 +765,24 @@ <div class="ulist"><ul> <li> <p> -<tt>buffer</tt> is a pointer into the memory representation of the tree. It always +<code>buffer</code> is a pointer into the memory representation of the tree. It always points at the current entry being visited. </p> </li> <li> <p> -<tt>size</tt> counts the number of bytes left in the <tt>buffer</tt>. +<code>size</code> counts the number of bytes left in the <code>buffer</code>. </p> </li> <li> <p> -<tt>entry</tt> points to the current entry being visited. +<code>entry</code> points to the current entry being visited. </p> </li> </ul></div> </dd> <dt class="hdlist1"> -<tt>struct traverse_info</tt> +<code>struct traverse_info</code> </dt> <dd> <p> @@ -793,40 +791,40 @@ <div class="ulist"><ul> <li> <p> -<tt>prev</tt> points to the traverse_info which was used to descend into the -current tree. If this is the top-level tree <tt>prev</tt> will point to +<code>prev</code> points to the traverse_info which was used to descend into the +current tree. If this is the top-level tree <code>prev</code> will point to a dummy traverse_info. </p> </li> <li> <p> -<tt>name</tt> is the entry for the current tree (if the tree is a subtree). +<code>name</code> is the entry for the current tree (if the tree is a subtree). </p> </li> <li> <p> -<tt>pathlen</tt> is the length of the full path for the current tree. +<code>pathlen</code> is the length of the full path for the current tree. </p> </li> <li> <p> -<tt>conflicts</tt> can be used by callbacks to maintain directory-file conflicts. +<code>conflicts</code> can be used by callbacks to maintain directory-file conflicts. </p> </li> <li> <p> -<tt>fn</tt> is a callback called for each entry in the tree. See Traversing for more +<code>fn</code> is a callback called for each entry in the tree. See Traversing for more information. </p> </li> <li> <p> -<tt>data</tt> can be anything the <tt>fn</tt> callback would want to use. +<code>data</code> can be anything the <code>fn</code> callback would want to use. </p> </li> <li> <p> -<tt>show_all_errors</tt> tells whether to stop at the first error or not. +<code>show_all_errors</code> tells whether to stop at the first error or not. </p> </li> </ul></div> @@ -839,33 +837,33 @@ <div class="sectionbody"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>init_tree_desc</tt> +<code>init_tree_desc</code> </dt> <dd> <p> - Initialize a <tt>tree_desc</tt> and decode its first entry. The buffer and + Initialize a <code>tree_desc</code> and decode its first entry. The buffer and size parameters are assumed to be the same as the buffer and size - members of <tt>struct tree</tt>. + members of <code>struct tree</code>. </p> </dd> <dt class="hdlist1"> -<tt>fill_tree_descriptor</tt> +<code>fill_tree_descriptor</code> </dt> <dd> <p> - Initialize a <tt>tree_desc</tt> and decode its first entry given the sha1 of - a tree. Returns the <tt>buffer</tt> member if the sha1 is a valid tree + Initialize a <code>tree_desc</code> and decode its first entry given the sha1 of + a tree. Returns the <code>buffer</code> member if the sha1 is a valid tree identifier and NULL otherwise. </p> </dd> <dt class="hdlist1"> -<tt>setup_traverse_info</tt> +<code>setup_traverse_info</code> </dt> <dd> <p> - Initialize a <tt>traverse_info</tt> given the pathname of the tree to start - traversing from. The <tt>base</tt> argument is assumed to be the <tt>path</tt> - member of the <tt>name_entry</tt> being recursed into unless the tree is a + Initialize a <code>traverse_info</code> given the pathname of the tree to start + traversing from. The <code>base</code> argument is assumed to be the <code>path</code> + member of the <code>name_entry</code> being recursed into unless the tree is a top-level tree in which case the empty string ("") is used. </p> </dd> @@ -877,7 +875,7 @@ <div class="sectionbody"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>tree_entry</tt> +<code>tree_entry</code> </dt> <dd> <p> @@ -887,7 +885,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>tree_entry_len</tt> +<code>tree_entry_len</code> </dt> <dd> <p> @@ -897,27 +895,27 @@ </p> </dd> <dt class="hdlist1"> -<tt>update_tree_entry</tt> +<code>update_tree_entry</code> </dt> <dd> <p> Walk to the next entry in a tree. This is commonly used in conjunction - with <tt>tree_entry_extract</tt> to inspect the current entry. + with <code>tree_entry_extract</code> to inspect the current entry. </p> </dd> <dt class="hdlist1"> -<tt>tree_entry_extract</tt> +<code>tree_entry_extract</code> </dt> <dd> <p> Decode the entry currently being visited (the one pointed to by - <tt>tree_desc's</tt> <tt>entry</tt> member) and return the sha1 of the entry. The - <tt>pathp</tt> and <tt>modep</tt> arguments are set to the entry’s pathname and mode + <code>tree_desc's</code> <code>entry</code> member) and return the sha1 of the entry. The + <code>pathp</code> and <code>modep</code> arguments are set to the entry’s pathname and mode respectively. </p> </dd> <dt class="hdlist1"> -<tt>get_tree_entry</tt> +<code>get_tree_entry</code> </dt> <dd> <p> @@ -935,16 +933,16 @@ <div class="sectionbody"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>traverse_trees</tt> +<code>traverse_trees</code> </dt> <dd> <p> - Traverse <tt>n</tt> number of trees in parallel. The <tt>fn</tt> callback member of - <tt>traverse_info</tt> is called once for each tree entry. + Traverse <code>n</code> number of trees in parallel. The <code>fn</code> callback member of + <code>traverse_info</code> is called once for each tree entry. </p> </dd> <dt class="hdlist1"> -<tt>traverse_callback_t</tt> +<code>traverse_callback_t</code> </dt> <dd> <p> @@ -953,27 +951,27 @@ <div class="ulist"><ul> <li> <p> -<tt>n</tt> counts the number of trees being traversed. +<code>n</code> counts the number of trees being traversed. </p> </li> <li> <p> -<tt>mask</tt> has its nth bit set if something exists in the nth entry. +<code>mask</code> has its nth bit set if something exists in the nth entry. </p> </li> <li> <p> -<tt>dirmask</tt> has its nth bit set if the nth tree’s entry is a directory. +<code>dirmask</code> has its nth bit set if the nth tree’s entry is a directory. </p> </li> <li> <p> -<tt>entry</tt> is an array of size <tt>n</tt> where the nth entry is from the nth tree. +<code>entry</code> is an array of size <code>n</code> where the nth entry is from the nth tree. </p> </li> <li> <p> -<tt>info</tt> maintains the state of the traversal. +<code>info</code> maintains the state of the traversal. </p> </li> </ul></div> @@ -983,7 +981,7 @@ same in the next callback invocation.</p></div> </dd> <dt class="hdlist1"> -<tt>make_traverse_path</tt> +<code>make_traverse_path</code> </dt> <dd> <p> @@ -994,11 +992,11 @@ </p> </dd> <dt class="hdlist1"> -<tt>traverse_path_len</tt> +<code>traverse_path_len</code> </dt> <dd> <p> - Calculate the length of a pathname returned by <tt>make_traverse_path</tt>. + Calculate the length of a pathname returned by <code>make_traverse_path</code>. This utilizes the memory structure of a tree entry to avoid the overhead of using a generic strlen(). </p> 